home *** CD-ROM | disk | FTP | other *** search
/ Chip 1997 March / CHIP Mart 1997.iso / prg / DEVIL20 / README.TXT < prev    next >
Encoding:
Text File  |  1995-10-31  |  22.6 KB  |  483 lines
  1. Welcome to DEVIL, the Descent Editor for Vertices, Items and Levels at all.
  2.  
  3.   ____________________________________          _________________________
  4.  /                /            /     /\        /\     \            \     \
  5. /________________/____________/_____/  \      /  \_____\____________\_____\
  6. \                \            \     \   \    /   /     /            /     /
  7.  \____     ___    \     _______\     \   \  /   /     /___      ___/     /
  8.       \    \  \    \    \/______\     \   \/   /     /   /    /   /     /
  9.        \    \  \    \            \     \  ||  /     /   /    /   /     /____
  10.       / \    \  \    \     _______\     \ || /     /\  /    /\  /     /     \
  11.      /___\    \/_\    \    \/______\     \__/     /__\/    /__\/     /_______\
  12.      \                 \            \            /            /              /
  13.       \_________________\____________\__________/____________/______________/
  14.           (thanks to Catalin-Andrei Stefanescu for the new ASCII art)
  15.                     
  16.              This is the README.TXT for version V2.00c
  17.         
  18.                Mail address: ubdb@rz.uni-karlsruhe.de
  19.       Home page: http://wwwrzstud.rz.uni-karlsruhe.de/~ubdb/index.html 
  20.  
  21. DEVIL is free software, and you are welcome to redistribute it under certain
  22. conditions, therefore DEVIL comes with ABSOLUTELY NO WARRANTY;
  23. for details see the file 'COPYING'. go32.exe is copyright by DJ Delorie;
  24. for copying this see 'COPYING.DJ'. The graphics library is copyright
  25. by Csaba Biegel; see 'COPYING.CB'. You get GNU-C with source-code on nearly 
  26. every ftp-site (for example ftp.uni-stuttgart.de).
  27.  
  28. If you want to sell Devil on a Shareware-CD or something like that, remember
  29. that this program is Freeware, therefore I won't get a cent from the people
  30. using this program. So if you make money with Devil think about spending
  31. some bucks to the author.
  32.  
  33. Devil is sponsored by the german magazine "PC PLAYER". They are
  34. paying me some money to encourage further development of Devil :-)).
  35. In return they asked me to be allowed to show up in the new
  36. title screen. There is no other obligation. DEVIL IS STILL FREEWARE!
  37.  
  38. PC PLAYER can be reached by E-Mail at devil@pcplayer.mhs.compuserve.com
  39.  
  40. ATTENTION:
  41.  There is a special driver for S3 cards which uses the accelerator
  42.  functions of the card. If you want something like this for your (not S3)
  43.  card, too, please mail me a specification and I will see what I can do.
  44.  
  45.  There is a new Devil Mailing list, to subscribe send a mail with the
  46.  subject DEVIL-FULL-SUB to DevilML@aol.com. I'm subscribed in this list, too,
  47.  so please mail any questions about how to use Devil to this list and not
  48.  directly to me. If you only want to get mails if a new version of Devil is
  49.  released, send a mail with the subject DEVIL-ANNOUNCE-SUB to DevilML@aol.com.
  50.  
  51.   CONTENTS:
  52.   
  53.   [0] THE VERSION NUMBERS.
  54.   
  55.   [1] INSTALLING DEVIL
  56.       [1a] What do I need to run DEVIL ?
  57.       [1b] How to install this thing ?
  58.       [1c] DEVIL crashes before the titlescreen appears. 
  59.       [1d] DEVIL crashes after the titlescreen has appeared.
  60.  
  61.   [2] BUILDING LEVELS
  62.       [2a] Building a level.
  63.       [2b] Including the level in descent (easy way).
  64.       [2c] Including the level in descent/Compiling your own HOG-files.
  65.       [2d] Extracting the original levels.
  66.       [2e] Extracting other files.
  67.       [2f] Restoring the original descent.
  68.       [2g] Copying macros.
  69.  
  70.   [3] BUGS AND OTHER WELL KNOWN FEATURES
  71.       [3a] How many bugs I've to expect ?
  72.       [3b] Bugtypes.
  73.       [3c] Report a bug.
  74.  
  75.   [4] FURTHER PLANS
  76.       [4a] Next weeks.
  77.       [4b] Next months.
  78.       [4c] Never.
  79.       
  80.   [5] ONE OR TWO WORDS TO THE SOURCECODE
  81.       [5a] Why is DEVIL.INI so long?
  82.       [5b] Sourcecode itself.
  83.       [5c] Extending DEVIL.
  84.       [5d] Recompiling DEVIL.
  85.  
  86.   [A] UPDATES
  87.   
  88.   [B] Things I've tried without success.
  89.   
  90. [0] THE VERSION NUMBERS.
  91.  Since version V1.0a DEVIL is numbered in the following way:
  92.  The full working, official release is called V1.0, V1.1 and so on.
  93.  The beta-testing versions are called V1.0a, V1.0b, V1.0c and so on.
  94.  Please spread this thing as wide as you can.
  95.  Minor updates and bugfixes will be called V1.01, V1.02...
  96.  
  97. [1] INSTALLING DEVIL
  98.  
  99.  [1a] What do I need to run DEVIL ?
  100.   To run DEVIL you need the following things: 
  101.    1. DESCENT 1 registered version (I won't release a editor for the shareware
  102.       version because the guys from Parallax don't want this).
  103.    2. A fast computer with coprocessor (the program isn't optimized in
  104.       any way yet, especially I do all the calculations needed for
  105.       plotting with floating point, so without a copro it's very very very
  106.       very slow, but you can try it with emu387 (is not included).
  107.       On a 486/66 it should be quite good).
  108.    3. A VESA-compatible graphics card.
  109.       
  110.  [1b] How to install this thing ?
  111.   If you have the devilXXX.zip file just pkunzip it with '-d' (IMPORTANT!!)
  112.   in the descent directory. In your DESCENT directory is now a directory 
  113.   called DEVIL with the two subdirectories LEVELS and MACROS. 
  114.   
  115.   The resolution which is used by Devil you can set in the devil.ini file.
  116.   
  117.  [1c] DEVIL crashes before the titlescreen appears. Help?
  118.   If DEVIL crashes with a message like General Protection Fault or something
  119.   like this, try a clean configuration only with HIMEM.SYS from MSDOS. This
  120.   should work. 
  121.   
  122.   I don't know how to use Win95/Windows 3.1 and Devil but I know
  123.   that there are some guys who have managed to do this. Try a short notice
  124.   in the mailing list for help.
  125.   
  126.   If you get no message and Devil just quits after you started it, it is
  127.   possible that Devil couldn't initialize the graphics mode. Then have a
  128.   look at the DEVIL.BAT file. There are some drivers mentioned. Perhaps you
  129.   can find one with a name which is similar to your card. Then change the line
  130.     set grx20drv=vesa
  131.   into
  132.     set grx20drv=<drivername>
  133.   Of course you must replace <drivername> with the name of the driver
  134.   (i.e. cl5426)
  135.   You can try to load a resident VESA-bios, too.
  136.   
  137.   It is also possible that your graphics card cannot handle the resolution
  138.   which is currently set in the devil.ini file.
  139.  
  140.  [1d] DEVIL crashes after the screen has appeared.
  141.   Perhaps your level-file is corrupted. Try starting devil with
  142.    devil /nocfg
  143.  
  144. [2] BUILDING LEVELS
  145.  [2a] Building a level.
  146.   Start devil.bat. If it does some output and then returns to the DOS-prompt
  147.   see the previous sections. 
  148.   
  149.   If DEVIL has started, build an level. This is not an easy task, but 
  150.   I'm sure you will see how it works.
  151.   See the doc-files for documentation. You can find them in the Docs 
  152.   directory. The saved levels will be in the levels-directory (that's not very
  153.   surprising, I suppose).
  154.  
  155.  [2b] Including the level in DESCENT (easy way).
  156.   Just copy your levelfile in the DESCENT directory and name it
  157.   LEVEL01.RDL (the 01 can be replaced by 01-27,S1-S3). DESCENT will
  158.   load this level automatically and replace the original level. 
  159.   
  160.  [2c] Including the level in descent/Compiling your own HOG-files.
  161.   If you want to produce your own missions you can compile your own
  162.   HOG-files with hogfile.exe. It will ask you all necessary data
  163.   and produce the specified HOG-file. If this HOG-file and the corresponding
  164.   MSN-file is in the DESCENT-directory, DESCENT will recognize this and
  165.   ask you which mission you want to play. You can also use rdl2hog and 
  166.   makemsn available at the Interplay site which are much more comfortable than
  167.   little hogfile.exe.
  168.   
  169.  [2d] Extracting the original levels.
  170.   This is done with extract.exe. Assuming that you will extract
  171.   the level 01, type in the levels-directory (!):
  172.    C:\DESCENT\DEVIL\LEVELS> ..\extract.exe level01.rdl ..\..\descent.hog
  173.   Instead of 01 you can write 01-27, S1-S3 (S must be uppercase).
  174.   The last parameter is the hog-file from which you want to 
  175.   extract, if it's '..\..\descent.hog' you can omit it.
  176.   The HOG-file is not changed. Try '$' instead of a 'level01.rdl' for the
  177.   contents of the HOG-file. Extract works also with other non-original
  178.   HOG-files. 
  179.  
  180.  [2e] Extracting other files.
  181.   The same thing as extracting the levels. 
  182.  
  183.  [2f] Copying macros.
  184.   If your friend has build some macros you want to include, just copy
  185.   them in your macros directory and start DEVIL.
  186.  
  187. [3] BUGS AND OTHER WELL KNOWN FEATURES
  188.  
  189.  [3a] How many bugs I've to expect ?
  190.   Tip: Save early and save often (as you know it from several games)
  191.   and sometimes with different filenames. 
  192.   I hope there are not so many bugs that are destroying your savefile or
  193.   make DEVIL not to read saved files, but I guarantee for nothing. If
  194.   you've a really, really great level that you've build for hours and hours
  195.   and DEVIL won't load him anymore, send me an EMail with a short message
  196.   what you've done last and what's in the file devil.err. It's always
  197.   a good idea to look in the file devil.err, perhaps you can do
  198.   some repair for yourself.
  199.   
  200.  [3b] Bugtypes.
  201.   I distinguish the following bugtypes:
  202.    A. Real, heavy bug: DEVIL crashes down with a message like
  203.        General Protection Fault
  204.       and a lot of registers and numbers and so on.
  205.       If you've discoverd such a bug I hope you've saved your work so
  206.       far. Please send me the clear readable message and the last few
  207.       steps you've made before the crash, so I can see what to do.
  208.    B. Middle bug: DEVIL crashes not really down, but goes to the DOS-prompt.
  209.       In this case it's a good idea to look in the file DEVIL.ERR.
  210.       Please send me the text written in there and the description of
  211.       your last few actions.
  212.    C. Weird bug: DESCENT won't load the level or crashes loading the level.
  213.       Also report to me (but first look at the documentation for possible
  214.       reasons). 
  215.    D. No bug: Suggestions to improve DEVIL. Also report to me.
  216.  
  217.  [3c] Report a bug.
  218.   Report a bug to: ubdb@rz.uni-karlsruhe.de
  219.   Please, please make a description what you have done when Devil has
  220.   crashed and mail the level you are working on with your bug report.
  221.  
  222. [4] Further plans
  223.  
  224.  [4a] Next weeks 
  225.   A cube move mode.
  226.   Making seven cubes out of one.
  227.   Some corridor generators.
  228.   Illuminating the mine automatically.
  229.   
  230.  [4b] Next months
  231.   Save/read hogfiles directly and special Devil file format.
  232.   An Undo feature (perhaps this goes together with some sort of programming
  233.    language)
  234.   A setup program for DEVIL.INI, so you can change keys and menus and so on. 
  235.   Tune the plot-routine especially avoid the copro. 
  236.   If I get an idea how to do it, texture-mapping on one cube, so you
  237.    can see it from the inside. 
  238.   
  239.  [4c] Never
  240.   A bitmap editor.
  241.   An editor for sounds or decoding the soundfile (because of lack of
  242.    knowledge).
  243.   
  244. [5] ONE OR TWO WORDS TO THE SOURCECODE
  245.  
  246.  [5a] Why is DEVIL.INI so long?
  247.   I've tried to keep as much data as possible out of the real sourcecode,
  248.   especially the data which refers to the keys, the menustructure and
  249.   the DESCENT data, so you can edit or complete it without compiling
  250.   DEVIL once again. I will release a setup program for adding something
  251.   to DEVIL.INI but if you're a tough guy, you can try to understand and
  252.   modify it with a normal editor (there are some comments in it).
  253.   
  254.  [5b] Sourcecode itself.
  255.   If you're trying to understand the sourcecode I must give you one hint:
  256.   The WALLS are named DOORS in the sourcecode and the SIDES are called
  257.   WALLS. It's bit confusing, but has historical reasons (I first thought
  258.   the WALLS are only DOORS). I suppose you'll be astonished at the do_event.c
  259.   file especially the function array do_event. I've done it this way and
  260.   not with a switch() because I think in this way it's easier to extend.
  261.   Just put your procedure name at the end of this array, an corresponding
  262.   entry in the enum evcodes in do_event.h, and the number of this
  263.   evcode as an entry in DEVIL.INI/MENU.INI.
  264.   
  265.  [5c] Extending DEVIL.  
  266.   In my opinion, the best way to extend DEVIL is to send me your sourcecode
  267.   (of course). I will put a node in the credits and make an event in
  268.   DEVIL for it.
  269.   
  270.  [5d] Recompiling DEVIL.
  271.   If you want to recompile DEVIL on another compiler, just have a look at
  272.   the w_system.c/w_system.h files. They contain all non-ANSI-C-routines DEVIL
  273.   needs. The rest of DEVIL is strict ANSI-C. The only non-ANSI-C
  274.   convention is that an 'int' is 4 bytes long.
  275.   Please send me an E-Mail if you recompile DEVIL on another compiler so
  276.   I can always give you the newest source-code.
  277.   
  278. [A] UPDATES
  279.  The latest release is always available at
  280.   http://www.uni-karlsruhe.de/~ubdb/index.html (my site)
  281.   http://www.interplay.com/website/devil.html (official US site)
  282.   US: The Integrated Connection BBS: 317-921-8619
  283.   UK: The Shed BBS: 
  284.   Australia: Southern Acces BBS: 61-53-428357
  285.   
  286.  0.95b - first release, a bit chaotic, COPYING files missing (in some cases),
  287.      wrong DOC file.
  288.  0.96b - Changed tiny bug with alternate exit, switch for doors in devil.ini
  289.      renamed, correct DOC file, complete README.TXT.
  290.  0.96b2  Fixed a lot of bugs: 
  291.        - Connecting cube with itself is no longer possible.
  292.        - Killing the status line sometimes.
  293.        - Choosing does not implement beaming anymore.
  294.        - Default filename (also change in devil.ini)
  295.        - Deleting is now possible with the current object if it's tagged.
  296.      The current object is just set to the previous (or next) object.
  297.        - Saving is no longer aborted, if a thing is out of bounds, but
  298.      a warning is printed if you want to ignore this. Also the exit side.
  299.        - If you enter something via keybord you can't delete too much anymore.
  300.        - Fixed bug entering strings: now it's possible to use spaces.
  301.        - Status line strings are now shortened if too long.
  302.        - No "General Protection Fault" if you tag a non existing wall.
  303.        - tuned bitmap routine (wasn't that difficult)
  304.      introduced: g, G for fitting to bitmap/side
  305.        - Numlock is now turned on at start.
  306.        - Normal quit made.
  307.        - Fixed bug in initio with doortextures
  308.        - Tried to fixed bug with macro saving but..-
  309.      KNOWN BUGS:
  310.        - Numlock on/off with keyboard LED does not work (look at the screen)
  311.        - Saving the same macro under several filenames will rename the first
  312.      saved macro (but on the disk there are two files, I hope). 
  313.      Try exiting and loading devil again.
  314.  0.97  - Fixed the damned bug with the macros.
  315.        - In wallmode now the texture for the wall side is shown.
  316.        - Fixed the "General Protection Fault" bug with producers that
  317.      produce nothing.
  318.        - Fixed another "GPF" when you run at the beginning of the doortypes.
  319.        - Introduced texture1&texture2 in wall menu.
  320.        - A normal texture2 is now also a wall texture 1.
  321.      KNOWN BUGS:
  322.        - Numlock on/off with keyboard LED still does not work 
  323.      (look at the screen)
  324.        - Changing textures with tagged walls in wall mode doesn't work.
  325.  0.99  - Made the SOURCE-code portable (with system.c/system.h)
  326.        - VGA-version is now built-in.
  327.        - fixed a bug in door textures.
  328.        - corrected the calculation of the texture coords
  329.          (works now even with very weird wall).
  330.        - fixed bug in the convex/weird-routine.
  331.        - added align to axis.
  332.        - you can't set the exit on a wall anymore.
  333.        - improved the helptxt.
  334.        - changed violet lines in texture/plot window.
  335.        - added "make room"-feature.
  336.        - fixed bug with left upper movebutton.
  337.        - fixed bug moving tagged cubes: they're now first all moved and then
  338.          checked, not moved and checked one by one.
  339.        - added "special tag" for points.
  340.        - made hogfile-sampler.
  341.        - changed drawing of tagged lines to one-point-thick lines
  342.          because of system.c/system.h.
  343.        - introduced changing rotating angle for fitbitmap.
  344.        - fixed bug that produced a 0-Byte file if you aborted saving macros.
  345.        - added the "align bitmaps"-feature.
  346.        - added an other rotating mode for cubes (with 4 & 6) where the current
  347.          cube is not rotated.
  348.        - changed the displaying of light&coords.
  349.        - Internal menu is now working completely.
  350.        - added scaling of macros&textures.
  351.        - introduced seperate rotation angle for things.
  352.        - you can insert now a macro on the exit.
  353.        - current position&direction is shown permanently.
  354.        - added growing&shrinking cubes and walls.
  355.        KNOWN BUGS: more I can describe.
  356.  1.0a  - added button for calculating textures.
  357.        - fixed the crash if you try to move a wall.
  358.        - now showing hotkeys in menus.
  359.        - connections for macros are now aligned vice versa 
  360.          (the macro is aligned to the current side).
  361.        - fixed the bug with the orientation of the second texture.
  362.        - crash if changing in wall mode.
  363.        - movebuttons won't work with mouse
  364.        - thing texture
  365.        - door texture
  366.        - killing of texture
  367.        - moving down in menu
  368.        - growing&shrinking now calculating textures and door grfx
  369.        - Clicking on scrolled data field is possible now.
  370.        - The doors are now correct changed if you change the animation.
  371.        - Setting door open - switch is now working without an error message.
  372.        - The items/hostages are now shown yellow not blue like the tagged 
  373.          objects.
  374.        - A blowdoor is now initialized with correct values&texture.
  375.        - You can now stretch the bitmap in 'fit bitmap' in x/y direction
  376.          (try switching numlock on/off).
  377.        - A thing is now inserted with the top to the current wall.
  378.        - Connections are now done with the variable UConn. in Internal menue.
  379.        - Hostages work now.
  380.        - Cubesize is now restricted (cause of the textures).
  381.        - Textures can now be selected with the mouse.
  382.        - Level reading tolerates now minor bugs.
  383.        - I hope the open-at-end bug is fixed.
  384.        - GPF if changing cube from producer to normal type is fixed.
  385.        - Arrange bitmaps works now.
  386.        - Source code is now strict ANSI-C.
  387.        - Fixed bug with Ins in side mode if a cube is surrounded by other 
  388.          cubes.
  389.        - Changed the read level routine a bit (can now read level26).
  390.        - Better map (try it, with lines of in Drawing Menu).
  391.        - Font is changed (hope that fixes the problems with several grfx 
  392.          cards).
  393.        - Added shift+left mousebutton for tagging several objects.
  394.        - Added tag box for tagging several objects
  395.        - Saving now checks for duplicate reactors and keys and starts with
  396.          illegal numbers. Also for reactors in no 'reactor'-cubes.
  397.        - You can change the level-name shown in DESCENT.
  398.        - Light shading feature added.
  399.        - Insert points.
  400.        - Insert&Delete sides with tagged walls.
  401.        - Shrink&grow now work with grid.
  402.        - You can lock side, so their texture is not calculated if you move
  403.          their points.
  404.        - Fit bitmap is now with&without tagged sides.
  405.        - Size of things is now correct (you won't see a difference).
  406.        - You can use the cube/side tags in side/point mode.
  407.        - If you leave DEVIL it starts with the same level on the same
  408.          position.
  409.        - You're asked is you want to leave DEVIL without saving changed
  410.          you've made.
  411.        - The play level feature is added.
  412.  1.0b  - Fixed little bug with text in the left upper corner by fit bitmap.
  413.        - Changed exit codes for handling GPFs.
  414.        - Changed name of the exe-file.
  415.        - works only with V1.4
  416.  1.0c  - works now with V1.0 and V1.4
  417.        - if macro saving is aborted, no file is created anymore.
  418.        - in macro choosing text is now correct even if you've overwritten
  419.          a macro.
  420.        - 'side lock' is now copied in macros & saved with levels.
  421.        - fixed a bug in savecube with the producers.
  422.        - size of things in old levels is now set & plot correctly.
  423.  1.0   - fixed the bugs with tagging.
  424.        - you can switch now between x-tagged display mode and normal tagged
  425.          display mode.
  426.        - introduced the number of tagged objects in the upper right corner.
  427.        - fixed the bug with updating the texture window.
  428.        - fixed the mouse bug if you click buttons rapidly.
  429.        - Devil now changes to cube mode after making a macro.
  430.        - Devil works with DPMI
  431.        - S3 cards can use the accelerated line function of the card
  432.          (have a look in the devil.bat file)
  433.        - Fit bitmap in VGA mode won't work.
  434.  1.01  - fixed some more bugs with tagging (when connecting cubes,
  435.          light shading and align bitmaps).
  436.        - changed the shape of the hostages.
  437.        - S3 cards can now use the accelerated rectangle fill function also.
  438.        - fixed the bug with the producers who forget their data.
  439.        - you can now make a macro with a connected side as reference.
  440.        - the old connect cubes feature is now available with Shift+Del.
  441.          The delete all feature is only available over the menu.
  442.        - Fixed the bug with 'Bitmaptype 13 not implemented'.
  443.        - The whole file is now a bit more strict ANSI:
  444.          <string.h> is included.
  445.      Constant strings are no longer changed.
  446.      connect() is now called connectsides() because it collides with
  447.       a Linux function.
  448.        - The z-key in Modify-Mode now works.
  449.        - A simple statistic is included.
  450.  1.02  - fixed the GPF with the animation of the doors.
  451.        - the new connect cubes feature is now working (with Del).
  452.        - a little coordinate system is shown.
  453.        - fixed the GPF when changing 'no switch' to 'no switch'.
  454.        - walls with 'nothing but switch' have a texture 'Nothing' now.
  455.        - fixed the problem with the tagging with the mouse with the box
  456.          and the white lines.
  457.        - now Devil know the Descent limits and gives warnings.
  458.        - hope I fixed the bug with the play-level feature.
  459.  2.00 (not yet completed)
  460.        - new graphics interface
  461.        - macro viewer & changer
  462.        - loading&handling several levels
  463.        
  464. Have a good time, build many levels, bomb all enemies and send me an email
  465.  
  466. Achim (ubdb@rz.uni-karlsruhe.de)
  467.  
  468. The Tao of programming
  469. ----------------------
  470.  
  471.  Master : The Tao of programming is in every program,
  472.           no matter of how insignificant it is.
  473.  Student: Really in every program?
  474.  Master : Yes, in every program.
  475.  Student: Is the Tao of programming in a handheld-calculator?
  476.  Master : It is in a handheld-calculator.
  477.  Student: Is the Tao even in a digital wrist watch?
  478.  Master : It is even in a digital wrist watch.
  479.  Student: And is the Tao of programming in a DOS for a PC?
  480.  The master coughed, shifted his position slightly and said:
  481.           'The lesson is over for today.'
  482.  
  483.